JAMSRESTAPI Web Service
PutFolder_PutFolder
JAMSRESTAPI Web Service > All Operations Resource Group : Folder_PutFolder (Put)

Resource Path: /api/folder

Uri: http://doc.jamsscheduler.com/api/folder

Description
Updates an existing folder definition
Request

The request body is of type Folder.

The folder definition

Overview

Folder
description : string
parameters : Array[Param]
allowEntry : boolean
dataType : string
defaultFormat : string
defaultValue : string
encrypt : boolean
helpText : string
hide : boolean
inherited : boolean
jobID : integer
lastChangeUTC : string
length : integer
mustFill : boolean
parameterOrigin : string
paramId : integer
paramName : string
prompt : string
required : boolean
sequence : integer
uppercase : boolean
validationData : string
validationType : string
variableID : integer
variableName : string
variableNameIsRelative : boolean
properties : Array[PropertyValue]
propertyName : string
categoryName : string
categorySortOrder : integer
displayName : string
propertyId : integer
typeName : string
typeNameSSO : string
toolTip : string
description : string
editor : string
mergeOption : string
sortOrder : integer
inheritedFromType : string
inheritedFromId : integer
inheritedFromName : string
readOnly : boolean
browsable : boolean
defaultValue : object
currentValue : object
encryptionId : integer
newEncryptedValue : string
folderID : integer
folderName : string
parentFolderID : integer
parentFolderName : string
qualifiedName : string
elements : Array[Element]
elementName : string
elementTypeName : string
elementTypeId : integer
elementId : integer
elementUid : string
ownerUid : string
inherited : boolean
inheritedFromType : string
inheritedFromId : integer
inheritedFromName : string
elementKind : string
elementState : string
properties : Array[PropertyValue]
propertyName : string
categoryName : string
categorySortOrder : integer
displayName : string
propertyId : integer
typeName : string
typeNameSSO : string
toolTip : string
description : string
editor : string
mergeOption : string
sortOrder : integer
inheritedFromType : string
inheritedFromId : integer
inheritedFromName : string
readOnly : boolean
browsable : boolean
defaultValue : object
currentValue : object
writeToEntry : boolean
writeToHistory : boolean
tabName : string
sortOrder : integer
validateTypeNameSSO : string
formatString : string
addMenuText : string
categoryName : string
categoryAddMenuText : string
categorySortOrder : integer
properties : Array[PropertyValue]
propertyName : string
categoryName : string
categorySortOrder : integer
displayName : string
propertyId : integer
typeName : string
typeNameSSO : string
toolTip : string
description : string
editor : string
mergeOption : string
sortOrder : integer
inheritedFromType : string
inheritedFromId : integer
inheritedFromName : string
readOnly : boolean
browsable : boolean
defaultValue : object
currentValue : object
tagIds : Array[]
tags : Array[Tag]
tagId : integer
tagName : string
inheritedTagIds : Array[]
lastChangeUTC : string
lastChangedBy : string
acl : ACL
genericACL : Array[ACE]
identifier : string
inherited : boolean
flags : string
accessList : Array[string]
Response

The response body is of type string.

OK
See Also
All Operations Resource GroupJAMSRESTAPI Web Service